home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / texts / hsc.lha / hsc / example / README next >
Text File  |  1996-01-08  |  2KB  |  63 lines
  1.                          Example Project
  2.                         -----------------
  3.  
  4. This directory contains a small example project.
  5.  
  6. The sources are collected in "source_hsc/" and should be converted to
  7. "object_html/". This will be the directory where the "browsable" data
  8. will be located.
  9.  
  10. This text asumes that your current directory is
  11. "[hsc]/example/source_hsc/".
  12.  
  13. Description of sources:
  14. -----------------------
  15.  
  16. main.hsc              the project's intros page
  17. stupid.hsc            a simple page that can be reached from "main"
  18. macro.hsc             contains some macro definitions and is
  19.                       included into all files
  20. hugo/                 a subdirectory, where all information about
  21.                       Hugo is collected
  22. hugo/hugo.hsc         some information about Hugo
  23. hugo/hugo.gif         a picture of Hugo
  24.  
  25. Setting up the object directory:
  26. --------------------------------
  27.  
  28. For every directory in the source-dir, a corresponding directory
  29. with the same name has to be created. This can be done via
  30.  
  31.     makedir /object_html/hugo                    ; AmigaOS
  32.     mkdir   ../object_html/hugo                  ; Unix
  33.  
  34. As the picture is of no real use in the source-dir, you should move
  35. it to the object-dir:
  36.  
  37.     rename hugo/hugo.gif /object_html/hugo/      ; AmigaOS
  38.     mv hugo/hugo.gif /object_html/hugo/          ; Unix
  39.  
  40. Note that every file, that is not not a hsc-source or include
  41. file  hsc to be located somewhere in the object-dir.
  42.  
  43. Starting the conversion:
  44. ------------------------
  45.  
  46. Now you are ready to start 'make':
  47.  
  48.     make
  49.  
  50. Of course, you need to have a 'make' command installed in your search
  51. path. For AmigaOS, search "aminet:dev/*" for fitting a program.
  52.  
  53. After that, all html-objects in "object_html/" should be ready.
  54.  
  55. Note that there does not exist a "macro.html", because the there was
  56. no rule for this in the makefile. There is no rule neccessary,
  57. because "macro.hsc" is never converted alone, but only included by
  58. the other files. Additionally, "macro.hsc" contains no readable text
  59. or tags.
  60.  
  61. Take a look at the "makefile" to understand the basic concept of hsc.
  62.  
  63.